home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.n / winfo.n < prev    next >
Text File  |  1995-07-25  |  20KB  |  331 lines
  1.  
  2.  
  3.  
  4.      wwwwiiiinnnnffffoooo((((nnnn))))                     TTTTkkkk (((( ))))                      wwwwiiiinnnnffffoooo((((nnnn))))
  5.  
  6.  
  7.  
  8.      _________________________________________________________________
  9.  
  10.      NNNNAAAAMMMMEEEE
  11.           winfo - Return window-related information
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           wwwwiiiinnnnffffoooo _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  15.      _________________________________________________________________
  16.  
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           The wwwwiiiinnnnffffoooo command is  used  to  retrieve  information  about
  20.           windows  managed  by  Tk.   It  can  take any of a number of
  21.           different forms, depending  on  the  _o_p_t_i_o_n  argument.   The
  22.           legal forms are:
  23.  
  24.           wwwwiiiinnnnffffoooo aaaattttoooommmm _n_a_m_e
  25.                Returns a decimal string giving the integer  identifier  |
  26.                for  the  atom  whose  name is _n_a_m_e.  If no atom exists  |
  27.                with the name _n_a_m_e then a new one is created.            |
  28.  
  29.           wwwwiiiinnnnffffoooo aaaattttoooommmmnnnnaaaammmmeeee _i_d                                                  ||
  30.                Returns  the  textual  name  for the atom whose integer  |
  31.                identifier is _i_d.  This command is the inverse  of  the  |
  32.                wwwwiiiinnnnffffoooo aaaattttoooommmm command.  Generates an error if no such atom  |
  33.                exists.                                                  |
  34.  
  35.           wwwwiiiinnnnffffoooo cccceeeellllllllssss _w_i_n_d_o_w                                                 ||
  36.                Returns  a decimal string giving the number of cells in  |
  37.                the color map for _w_i_n_d_o_w.
  38.  
  39.           wwwwiiiinnnnffffoooo cccchhhhiiiillllddddrrrreeeennnn _w_i_n_d_o_w
  40.                Returns a list containing the path  names  of  all  the
  41.                children  of _w_i_n_d_o_w.  Top-level windows are returned as
  42.                children of their logical parents.
  43.  
  44.           wwwwiiiinnnnffffoooo ccccllllaaaassssssss _w_i_n_d_o_w
  45.                Returns the class name for _w_i_n_d_o_w.
  46.  
  47.           wwwwiiiinnnnffffoooo ccccoooonnnnttttaaaaiiiinnnniiiinnnngggg _r_o_o_t_X _r_o_o_t_Y
  48.                Returns the path name for  the  window  containing  the  |
  49.                point  given  by  _r_o_o_t_X and _r_o_o_t_Y.  _R_o_o_t_X and _r_o_o_t_Y are  |
  50.                specified in screen units (i.e.  any form acceptable to  |
  51.                TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss)  in  the  coordinate  system  of the root  |
  52.                window (if a virtual-root window manager is in use then  |
  53.                the  coordinate  system  of  the virtual root window is  |
  54.                used).  If no window in this application  contains  the  |
  55.                point  then  an empty string is returned.  In selecting  |
  56.                the  containing  window,  children  are  given   higher  |
  57.                priority  than  parents  and among siblings the highest  |
  58.                one in the stacking order is chosen.                     |
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/23/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      wwwwiiiinnnnffffoooo((((nnnn))))                     TTTTkkkk (((( ))))                      wwwwiiiinnnnffffoooo((((nnnn))))
  71.  
  72.  
  73.  
  74.           wwwwiiiinnnnffffoooo ddddeeeepppptttthhhh _w_i_n_d_o_w                                                 ||
  75.                Returns  a  decimal  string  giving the depth of _w_i_n_d_o_w  |
  76.                (number of bits per pixel).                              |
  77.  
  78.           wwwwiiiinnnnffffoooo eeeexxxxiiiissssttttssss _w_i_n_d_o_w                                                ||
  79.                Returns  1  if there exists a window named _w_i_n_d_o_w, 0 if  |
  80.                no such window exists.                                   |
  81.  
  82.           wwwwiiiinnnnffffoooo ffffppppiiiixxxxeeeellllssss _w_i_n_d_o_w _n_u_m_b_e_r                                        ||
  83.                Returns  a  floating-point  value  giving the number of  |
  84.                pixels in _w_i_n_d_o_w corresponding to the distance given by  |
  85.                _n_u_m_b_e_r.   _N_u_m_b_e_r  may  be specified in any of the forms  |
  86.                acceptable  to  TTTTkkkk____GGGGeeeettttSSSSccccrrrreeeeeeeennnnMMMMMMMM,  such  as  ``2.0c''  or  |
  87.                ``1i''.   The  return  value may be fractional;  for an  |
  88.                integer value, use wwwwiiiinnnnffffoooo ppppiiiixxxxeeeellllssss.
  89.  
  90.           wwwwiiiinnnnffffoooo ggggeeeeoooommmmeeeettttrrrryyyy _w_i_n_d_o_w
  91.                Returns  the  geometry  for   _w_i_n_d_o_w,   in   the   form
  92.                _w_i_d_t_hxxxx_h_e_i_g_h_t++++_x++++_y.  All dimensions are in pixels.
  93.  
  94.           wwwwiiiinnnnffffoooo hhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w
  95.                Returns a decimal  string  giving  _w_i_n_d_o_w's  height  in
  96.                pixels.  When a window is first created its height will
  97.                be 1 pixel;  the height will eventually be changed by a
  98.                geometry manager to fulfill the window's needs.  If you
  99.                need the  true  height  immediately  after  creating  a
  100.                widget,  invoke uuuuppppddddaaaatttteeee to force the geometry manager to
  101.                arrange it, or use wwwwiiiinnnnffffoooo rrrreeeeqqqqhhhheeeeiiiigggghhhhtttt to get the  window's
  102.                requested height instead of its actual height.
  103.  
  104.           wwwwiiiinnnnffffoooo iiiidddd _w_i_n_d_o_w
  105.                Returns  a  hexadecimal   string   indicating   the   X
  106.                identifier for _w_i_n_d_o_w.
  107.  
  108.           wwwwiiiinnnnffffoooo iiiinnnntttteeeerrrrppppssss
  109.                Returns a list whose members are the names of  all  Tcl
  110.                interpreters (e.g. all Tk-based applications) currently
  111.                registered for the display of the invoking application.
  112.  
  113.           wwwwiiiinnnnffffoooo iiiissssmmmmaaaappppppppeeeedddd _w_i_n_d_o_w
  114.                Returns 1111 if _w_i_n_d_o_w is currently mapped, 0000 otherwise.
  115.  
  116.           wwwwiiiinnnnffffoooo nnnnaaaammmmeeee _w_i_n_d_o_w
  117.                Returns _w_i_n_d_o_w's name (i.e. its name within its parent,
  118.                as  opposed  to its full path name).  The command wwwwiiiinnnnffffoooo  |
  119.                nnnnaaaammmmeeee .... will return the name of the application.
  120.  
  121.           wwwwiiiinnnnffffoooo ppppaaaarrrreeeennnntttt _w_i_n_d_o_w
  122.                Returns the path name of _w_i_n_d_o_w's parent, or  an  empty
  123.                string if _w_i_n_d_o_w is the main window of the application.
  124.  
  125.           wwwwiiiinnnnffffoooo ppppaaaatttthhhhnnnnaaaammmmeeee _i_d
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 7/23/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      wwwwiiiinnnnffffoooo((((nnnn))))                     TTTTkkkk (((( ))))                      wwwwiiiinnnnffffoooo((((nnnn))))
  137.  
  138.  
  139.  
  140.                Returns the path name of the window whose X  identifier
  141.                is  _i_d.   _I_d  must  be a decimal, hexadecimal, or octal
  142.                integer and must correspond to a window in the invoking
  143.                application.
  144.  
  145.           wwwwiiiinnnnffffoooo ppppiiiixxxxeeeellllssss _w_i_n_d_o_w _n_u_m_b_e_r
  146.                Returns the number of pixels in _w_i_n_d_o_w corresponding to  |
  147.                the  distance given by _n_u_m_b_e_r.  _N_u_m_b_e_r may be specified  |
  148.                in any of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss, such as  |
  149.                ``2.0c''  or  ``1i''.   The  result  is  rounded to the  |
  150.                nearest integer value;  for a  fractional  result,  use  |
  151.                wwwwiiiinnnnffffoooo ffffppppiiiixxxxeeeellllssss.
  152.  
  153.           wwwwiiiinnnnffffoooo rrrreeeeqqqqhhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w
  154.                Returns a  decimal  string  giving  _w_i_n_d_o_w's  requested
  155.                height,  in pixels.  This is the value used by _w_i_n_d_o_w's
  156.                geometry manager to compute its geometry.
  157.  
  158.           wwwwiiiinnnnffffoooo rrrreeeeqqqqwwwwiiiiddddtttthhhh _w_i_n_d_o_w
  159.                Returns a  decimal  string  giving  _w_i_n_d_o_w's  requested
  160.                width,  in  pixels.  This is the value used by _w_i_n_d_o_w's
  161.                geometry manager to compute its geometry.
  162.  
  163.           wwwwiiiinnnnffffoooo rrrrggggbbbb _w_i_n_d_o_w _c_o_l_o_r
  164.                Returns a list containing three decimal  values,  which  |
  165.                are   the   red,   green,  and  blue  intensities  that  |
  166.                correspond to _c_o_l_o_r in  the  window  given  by  _w_i_n_d_o_w.  |
  167.                _C_o_l_o_r  may  be specified in any of the forms acceptable  |
  168.                for a color option.
  169.  
  170.           wwwwiiiinnnnffffoooo rrrroooooooottttxxxx _w_i_n_d_o_w
  171.                Returns a decimal string giving  the  x-coordinate,  in
  172.                the root window of the screen, of the upper-left corner
  173.                of _w_i_n_d_o_w's border (or _w_i_n_d_o_w if it has no border).
  174.  
  175.           wwwwiiiinnnnffffoooo rrrroooooooottttyyyy _w_i_n_d_o_w
  176.                Returns a decimal string giving  the  y-coordinate,  in
  177.                the root window of the screen, of the upper-left corner
  178.                of _w_i_n_d_o_w's border (or _w_i_n_d_o_w if it has no border).
  179.  
  180.           wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnn _w_i_n_d_o_w
  181.                Returns the name of the screen associated with  _w_i_n_d_o_w,
  182.                in the form _d_i_s_p_l_a_y_N_a_m_e._s_c_r_e_e_n_I_n_d_e_x.
  183.  
  184.           wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnncccceeeellllllllssss _w_i_n_d_o_w
  185.                Returns a decimal string giving the number of cells  in  |
  186.                the default color map for _w_i_n_d_o_w's screen.               |
  187.  
  188.           wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnddddeeeepppptttthhhh _w_i_n_d_o_w                                           ||
  189.                Returns  a  decimal string giving the depth of the root  |
  190.                window of _w_i_n_d_o_w's screen (number of bits per pixel).    |
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 7/23/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      wwwwiiiinnnnffffoooo((((nnnn))))                     TTTTkkkk (((( ))))                      wwwwiiiinnnnffffoooo((((nnnn))))
  203.  
  204.  
  205.  
  206.           wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnhhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w                                          ||
  207.                Returns  a decimal string giving the height of _w_i_n_d_o_w's  |
  208.                screen, in pixels.                                       |
  209.  
  210.           wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnmmmmmmmmhhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w                                        ||
  211.                Returns  a decimal string giving the height of _w_i_n_d_o_w's  |
  212.                screen, in millimeters.                                  |
  213.  
  214.           wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnmmmmmmmmwwwwiiiiddddtttthhhh _w_i_n_d_o_w                                         ||
  215.                Returns  a  decimal string giving the width of _w_i_n_d_o_w's  |
  216.                screen, in millimeters.                                  |
  217.  
  218.           wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnvvvviiiissssuuuuaaaallll _w_i_n_d_o_w                                          ||
  219.                Returns  one  of  the following strings to indicate the  |
  220.                default visual type for _w_i_n_d_o_w's  screen:  ddddiiiirrrreeeeccccttttccccoooolllloooorrrr,  |
  221.                ggggrrrraaaayyyyssssccccaaaalllleeee,  ppppsssseeeeuuuuddddooooccccoooolllloooorrrr,  ssssttttaaaattttiiiiccccccccoooolllloooorrrr,  ssssttttaaaattttiiiiccccggggrrrraaaayyyy,  or  |
  222.                ttttrrrruuuueeeeccccoooolllloooorrrr.                                               |
  223.  
  224.           wwwwiiiinnnnffffoooo ssssccccrrrreeeeeeeennnnwwwwiiiiddddtttthhhh _w_i_n_d_o_w                                           ||
  225.                Returns  a  decimal string giving the width of _w_i_n_d_o_w's  |
  226.                screen, in pixels.                                       |
  227.  
  228.           wwwwiiiinnnnffffoooo ttttoooopppplllleeeevvvveeeellll _w_i_n_d_o_w                                              ||
  229.                Returns   the   path   name  of  the  top-level  window  |
  230.                containing _w_i_n_d_o_w.                                       |
  231.  
  232.           wwwwiiiinnnnffffoooo vvvviiiissssuuuuaaaallll _w_i_n_d_o_w                                                ||
  233.                Returns  one  of  the following strings to indicate the  |
  234.                visual  type  for   _w_i_n_d_o_w:   ddddiiiirrrreeeeccccttttccccoooolllloooorrrr,   ggggrrrraaaayyyyssssccccaaaalllleeee,  |
  235.                ppppsssseeeeuuuuddddooooccccoooolllloooorrrr, ssssttttaaaattttiiiiccccccccoooolllloooorrrr, ssssttttaaaattttiiiiccccggggrrrraaaayyyy, or ttttrrrruuuueeeeccccoooolllloooorrrr.      |
  236.  
  237.           wwwwiiiinnnnffffoooo vvvvrrrrooooooootttthhhheeeeiiiigggghhhhtttt _w_i_n_d_o_w                                           ||
  238.                Returns   the   height   of  the  virtual  root  window  |
  239.                associated with _w_i_n_d_o_w  if  there  is  one;   otherwise  |
  240.                returns the height of _w_i_n_d_o_w's screen.                   |
  241.  
  242.           wwwwiiiinnnnffffoooo vvvvrrrroooooooottttwwwwiiiiddddtttthhhh _w_i_n_d_o_w                                            ||
  243.                Returns the width of the virtual root window associated  |
  244.                with _w_i_n_d_o_w if there is  one;   otherwise  returns  the  |
  245.                width of _w_i_n_d_o_w's screen.                                |
  246.  
  247.           wwwwiiiinnnnffffoooo vvvvrrrroooooooottttxxxx _w_i_n_d_o_w                                                ||
  248.                Returns   the  x-offset  of  the  virtual  root  window  |
  249.                associated with _w_i_n_d_o_w, relative to the root window  of  |
  250.                its  screen.  This is normally either zero or negative.  |
  251.                Returns 0 if  there  is  no  virtual  root  window  for  |
  252.                _w_i_n_d_o_w.                                                  |
  253.  
  254.           wwwwiiiinnnnffffoooo vvvvrrrroooooooottttyyyy _w_i_n_d_o_w                                                ||
  255.                Returns   the  y-offset  of  the  virtual  root  window  |
  256.                associated with _w_i_n_d_o_w, relative to the root window  of  |
  257.                its  screen.  This is normally either zero or negative.  |
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 7/23/95)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      wwwwiiiinnnnffffoooo((((nnnn))))                     TTTTkkkk (((( ))))                      wwwwiiiinnnnffffoooo((((nnnn))))
  269.  
  270.  
  271.  
  272.                Returns 0 if  there  is  no  virtual  root  window  for  |
  273.                _w_i_n_d_o_w.
  274.  
  275.           wwwwiiiinnnnffffoooo wwwwiiiiddddtttthhhh _w_i_n_d_o_w
  276.                Returns a  decimal  string  giving  _w_i_n_d_o_w's  width  in
  277.                pixels.   When a window is first created its width will
  278.                be 1 pixel;  the width will eventually be changed by  a
  279.                geometry manager to fulfill the window's needs.  If you
  280.                need  the  true  width  immediately  after  creating  a
  281.                widget,  invoke uuuuppppddddaaaatttteeee to force the geometry manager to
  282.                arrange it, or use wwwwiiiinnnnffffoooo rrrreeeeqqqqwwwwiiiiddddtttthhhh to get  the  window's
  283.                requested width instead of its actual width.
  284.  
  285.           wwwwiiiinnnnffffoooo xxxx _w_i_n_d_o_w
  286.                Returns a decimal string giving  the  x-coordinate,  in
  287.                _w_i_n_d_o_w's  parent,  of the upper-left corner of _w_i_n_d_o_w's
  288.                border (or _w_i_n_d_o_w if it has no border).
  289.  
  290.           wwwwiiiinnnnffffoooo yyyy _w_i_n_d_o_w
  291.                Returns a decimal string giving  the  y-coordinate,  in
  292.                _w_i_n_d_o_w's  parent,  of the upper-left corner of _w_i_n_d_o_w's
  293.                border (or _w_i_n_d_o_w if it has no border).
  294.  
  295.  
  296.      KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  297.           atom,  children,  class,   geometry,   height,   identifier,
  298.           information,   interpreters,   mapped,  parent,  path  name,
  299.           screen, virtual root, width, window
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 7/23/95)
  328.  
  329.  
  330.  
  331.